Class Document

מסמך

מסמך שמכיל אובייקט Tab אחד או יותר, שכל אחד מהם מכיל טקסט עשיר ורכיבים כמו טבלאות ורשימות.

אפשר לפתוח או ליצור מסמכים באמצעות DocumentApp. 

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

שיטות בכיתה Document שמבצעות גישה ישירה לתוכן הטקסט ומשנה אותו פועלות בכרטיסייה הפעילה (בסקריפטים המצורפים למסמך מסוים) או בכרטיסייה הראשונה (אם הכרטיסייה הפעילה לא זמינה). אפשר להעביר סקריפטים שמסתמכים על השיטות האלה (לדוגמה, getBody()) כדי לתמוך בכרטיסיות באמצעות getTabs() ואז Tab.asDocumentTab().

Methods

שיטהסוג הערך המוחזרתיאור קצר
addBookmark(position)Bookmarkהוספת Bookmark ב-Position שצוין לכרטיסייה הראשונה, או לכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך.
addEditor(emailAddress)Documentהוספת המשתמש הנתון לרשימת העורכים של Document.
addEditor(user)Documentהוספת המשתמש הנתון לרשימת העורכים של Document.
addEditors(emailAddresses)Documentהוספת מערך המשתמשים הנתון לרשימת העורכים של Document.
addFooter()FooterSectionהוספת קטע של כותרת תחתונה, אם אין כזה, לכרטיסייה הראשונה. בסקריפטים שמוגדרים למסמך, הכותרת התחתונה תתווסף לכרטיסייה הפעילה.
addHeader()HeaderSectionהוספת קטע כותרת, אם אין כזה, לכרטיסייה הראשונה. בסקריפטים שמוגדרים למסמך, הוספת קטע כותרת לכרטיסייה הפעילה.
addNamedRange(name, range)NamedRangeהוספת NamedRange, שהוא Range עם שם ומזהה לשימוש אחזור מאוחר יותר, בכרטיסייה הראשונה. בסקריפטים שמוצמדים למסמך, הוספה בכרטיסייה הפעילה.
addViewer(emailAddress)Documentהוספת המשתמש הנתון לרשימת הצופים ב-Document.
addViewer(user)Documentהוספת המשתמש הנתון לרשימת הצופים ב-Document.
addViewers(emailAddresses)Documentהפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים ב-Document.
getActiveTab()Tabהפונקציה מקבלת את Tab הפעיל של המשתמש במסמך.
getAs(contentType)Blobאחזור התוכן הנוכחי של Document כ-blob מהסוג שצוין.
getBlob()Blobאחזור התוכן הנוכחי של Document כ-blob.
getBody()Bodyהפונקציה מאחזרת את הערך של Body בכרטיסייה הראשונה, או את הערך של DocumentBodySection בכרטיסייה הפעילה, עבור סקריפטים שמוגבלים למסמך.
getBookmark(id)Bookmarkהפונקציה מקבלת את Bookmark עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך.
getBookmarks()Bookmark[]הפונקציה מקבלת את כל האובייקטים מסוג Bookmark בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך.
getCursor()Positionהפונקציה מקבלת את הסמן של המשתמש בכרטיסייה הפעילה.
getEditors()User[]הפונקציה מקבלת את רשימת העורכים של Document הזה.
getFooter()FooterSectionהפונקציה מאחזרת את הקטע של הכותרת התחתונה בכרטיסייה הראשונה, או את הקטע של הכותרת התחתונה בכרטיסייה הפעילה, עבור סקריפטים שמוגדרים למסמך.
getFootnotes()Footnote[]הפונקציה מאחזרת את כל הרכיבים מסוג Footnote בגוף הכרטיסייה הראשונה, או בגוף הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך.
getHeader()HeaderSectionהפונקציה מאחזרת את קטע הכותרת של הכרטיסייה הראשונה, או את קטע הכותרת של הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך.
getId()Stringאחזור המזהה הייחודי של המסמך.
getLanguage()Stringהפונקציה מקבלת את קוד השפה של המסמך.
getName()Stringאחזור הכותרת של המסמך.
getNamedRangeById(id)NamedRangeהפונקציה מקבלת את NamedRange עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך.
getNamedRanges()NamedRange[]הפונקציה מקבלת את כל האובייקטים מסוג NamedRange בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך.
getNamedRanges(name)NamedRange[]הפונקציה מקבלת את כל האובייקטים מסוג NamedRange עם השם שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוצמדים למסמך.
getSelection()Rangeהפונקציה מקבלת את הבחירה של המשתמש בכרטיסייה הפעילה.
getSupportedLanguageCodes()String[]הפונקציה מקבלת את כל קודי השפות שנתמכים בקובצי Google Docs.
getTab(tabId)Tabהפונקציה מקבלת את ה-Tab עם המזהה שצוין.
getTabs()Tab[]הפונקציה מקבלת את כל ה-Tab שאינם בתצוגת עץ ושהם חלק מהמסמך.
getUrl()Stringאחזור כתובת ה-URL לגישה למסמך הנוכחי.
getViewers()User[]הפונקציה מקבלת את רשימת הצופים והמגיבים ב-Document הזה.
newPosition(element, offset)Positionיצירת Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגבלים למסמך.
newRange()RangeBuilderיצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמקושר למסמך.
removeEditor(emailAddress)Documentהסרת המשתמש הנתון מרשימת העורכים של Document.
removeEditor(user)Documentהסרת המשתמש הנתון מרשימת העורכים של Document.
removeViewer(emailAddress)Documentהסרת המשתמש מהרשימה של הצופים והמגיבים ב-Document.
removeViewer(user)Documentהסרת המשתמש מהרשימה של הצופים והמגיבים ב-Document.
saveAndClose()voidשמירת Document הנוכחי.
setActiveTab(tabId)voidהפונקציה מגדירה את Tab שנבחר על ידי המשתמש במסמך הנוכחי לכרטיסייה עם המזהה שצוין.
setCursor(position)Documentהגדרת הסמן של המשתמש, בהתאם ל-Position.
setLanguage(languageCode)Documentהגדרת קוד השפה של המסמך.
setName(name)Documentהגדרת כותרת המסמך.
setSelection(range)Documentהגדרת הבחירה של המשתמש בכרטיסייה הפעילה, בהתאם ל-Range.

מסמכים מפורטים

addBookmark(position)

הוספת Bookmark ב-Position שצוין לכרטיסייה הראשונה, או לכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך. כדי להוסיף סימנייה לכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.addBookmark(position). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

פרמטרים

שםסוגתיאור
positionPositionהמיקום של הסימנייה החדשה.

חזרה

Bookmark — הסימנייה החדשה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

הוספת המשתמש הנתון לרשימת העורכים של Document. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

הוספת המשתמש הנתון לרשימת העורכים של Document. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

הוספת מערך המשתמשים הנתון לרשימת העורכים של Document. אם אחד מהמשתמשים כבר נכלל ברשימת הצופים, השיטה הזו תגרום להסרת המשתמש מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך של כתובות האימייל של המשתמשים שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

הוספת קטע של כותרת תחתונה, אם אין כזה, לכרטיסייה הראשונה. בסקריפטים שמוגדרים למסמך, הכותרת התחתונה תתווסף לכרטיסייה הפעילה. כדי להוסיף קטע של כותרת תחתונה לכל כרטיסייה, משתמשים בשיטה DocumentTab.addFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

חזרה

FooterSection — הכותרת התחתונה של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

הוספת קטע כותרת, אם אין כזה, לכרטיסייה הראשונה. בסקריפטים שמוגדרים למסמך, הוספת קטע כותרת לכרטיסייה הפעילה. כדי להוסיף קטע כותרת לכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.addHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

חזרה

HeaderSection — כותרת הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

הוספת NamedRange, שהוא Range עם שם ומזהה לשימוש אחזור מאוחר יותר, בכרטיסייה הראשונה. בסקריפטים שמוצמדים למסמך, הוספה בכרטיסייה הפעילה. כדי להוסיף NamedRange בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.addNamedRange(name, range). השמות לא חייבים להיות ייחודיים. כמה טווחים שונים באותו מסמך יכולים לשתף את אותו שם, בדומה לכיתה ב-HTML. לעומת זאת, מזהים הם ייחודיים במסמך, כמו מזהה ב-HTML. אחרי שמוסיפים NamedRange למסמך, אי אפשר לשנות אותו, אפשר רק להסיר אותו.

כל סקריפט שגוגה למסמך יכול לגשת ל-NamedRange. כדי למנוע התנגשויות לא רצויות בין סקריפטים, מומלץ להוסיף למחרוזת ייחודית לתחילת השמות של הטווחים. 

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

פרמטרים

שםסוגתיאור
nameStringהשם של הטווח, שלא חייב להיות ייחודי. שמות של טווחים חייבים להכיל בין תו אחד ל-256 תווים.
rangeRangeטווח הרכיבים שרוצים לשייך לשם. הטווח יכול להיות הבחירה הפעילה, תוצאת חיפוש או טווח שנוצר באופן ידני באמצעות newRange().

חזרה

NamedRange — הNamedRange.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

הוספת המשתמש הנתון לרשימת הצופים ב-Document. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

הוספת המשתמש הנתון לרשימת הצופים ב-Document. אם המשתמש כבר נכלל ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים ב-Document. אם אחד מהמשתמשים כבר היה ברשימת העורכים, השיטה הזו לא תשפיע עליו.

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך של כתובות האימייל של המשתמשים שרוצים להוסיף.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

הפונקציה מקבלת את Tab הפעיל של המשתמש במסמך. סקריפט יכול לגשת רק לכרטיסייה הפעילה של המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט קשור למסמך. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

חזרה

Tab – ה-Tab הפעיל של המשתמש, או null אם הסקריפט לא מקושר למסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

אחזור התוכן הנוכחי של Document כ-blob מהסוג שצוין. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-MIME שאליו רוצים להמיר. יש תמיכה ב-'application/pdf' וב-'text/markdown'.

חזרה

Blob – המסמך הנוכחי כ-blob.

getBlob()

אחזור התוכן הנוכחי של Document כ-blob. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

חזרה

Blob – המסמך הנוכחי כ-blob.

getBody()

הפונקציה מאחזרת את הערך של Body בכרטיסייה הראשונה, או את הערך של DocumentBodySection בכרטיסייה הפעילה, עבור סקריפטים שמוגבלים למסמך. כדי לקבל את DocumentBodySection של כל כרטיסייה, משתמשים בשיטה DocumentTab.getBody().

כרטיסיות יכולות להכיל סוגים שונים של קטעים (לדוגמה, HeaderSection, FooterSection). הקטע הפעיל בכרטיסייה הוא Body.

שיטות הרכיבים ב-Document מעבירות את הגישה ל-Body הפעיל. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

חזרה

Body — הקטע של גוף הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

הפונקציה מקבלת את Bookmark עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך. כדי לקבל סימנייה בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getBookmark(id). השיטה הזו מחזירה את הערך null אם אין Bookmark כזה בכרטיסייה. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

פרמטרים

שםסוגתיאור
idStringהמזהה של Bookmark.

חזרה

Bookmark – ה-Bookmark עם המזהה הנתון, או null אם לא קיים Bookmark כזה בכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

הפונקציה מקבלת את כל האובייקטים מסוג Bookmark בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך. כדי לקבל את כל הסימניות בכל כרטיסייה, משתמשים בשיטה DocumentTab.getBookmarks(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

חזרה

Bookmark[] – מערך של אובייקטי Bookmark בכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getCursor()

הפונקציה מקבלת את הסמן של המשתמש בכרטיסייה הפעילה. סקריפט יכול לגשת לסמן של המשתמש שמפעיל אותו רק אם הסקריפט קשור למסמך. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

חזרה

Position – ייצוג של הסמן של המשתמש, או null אם למשתמש אין סמן בכרטיסייה או אם הסקריפט לא מקושר למסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getEditors()

הפונקציה מקבלת את רשימת העורכים של Document הזה.

חזרה

User[] – מערך של משתמשים עם הרשאת עריכה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

הפונקציה מאחזרת את הקטע של הכותרת התחתונה בכרטיסייה הראשונה, או את הקטע של הכותרת התחתונה בכרטיסייה הפעילה, עבור סקריפטים שמוגדרים למסמך. כדי לקבל את הקטע של הכותרת התחתונה של כל כרטיסייה, משתמשים ב-method ‏DocumentTab.getFooter(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

חזרה

FooterSection – הכותרת התחתונה של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

הפונקציה מאחזרת את כל הרכיבים מסוג Footnote בגוף הכרטיסייה הראשונה, או בגוף הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך. כדי לקבל את כל הערות השוליים בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getFootnotes().

קריאות ל-getFootnotes גורמות לחזרה על האלמנטים של הכרטיסייה. בכרטיסיות גדולות, כדאי להימנע מבקשות מיותרות לשימוש בשיטה הזו. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

חזרה

Footnote[] — הערות השוליים של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

הפונקציה מאחזרת את קטע הכותרת של הכרטיסייה הראשונה, או את קטע הכותרת של הכרטיסייה הפעילה בסקריפטים שמוגדרים למסמך. כדי לקבל את קטע הכותרת של כל כרטיסייה, משתמשים בשיטה DocumentTab.getHeader(). 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

חזרה

HeaderSection — הכותרת של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

אחזור המזהה הייחודי של המסמך. מזהה המסמך משמש עם DocumentApp.openById() כדי לפתוח מופע מסמך ספציפי.

חזרה

String – מזהה המסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLanguage()

הפונקציה מקבלת את קוד השפה של המסמך. זו השפה שמוצגת בקטע File > Language (קובץ > שפה) בעורך המסמך. יכול להיות שהיא לא השפה שבה המסמך נכתב בפועל.

חזרה

String – שפת המסמך, או null אם לא הוגדרה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

אחזור הכותרת של המסמך.

חזרה

String — שם המסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

הפונקציה מקבלת את NamedRange עם המזהה שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגדרים למסמך. כדי לקבל את NamedRange עם המזהה הנתון בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.getNamedRangeById(id). אם אין כזה NamedRange בכרטיסייה, השיטה מחזירה את הערך null. השמות לא בהכרח ייחודיים, גם בין כרטיסיות. כמה טווחים שונים באותה כרטיסייה יכולים לשתף את אותו שם, בדומה לכיתה ב-HTML. לעומת זאת, מזהים הם ייחודיים בכרטיסייה, כמו מזהה ב-HTML.

פרמטרים

שםסוגתיאור
idStringהמזהה של הטווח, שהוא ייחודי בכרטיסייה.

חזרה

NamedRange – ה-NamedRange עם המזהה שצוין, או null אם אין טווח כזה בכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

הפונקציה מקבלת את כל האובייקטים מסוג NamedRange בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוגדרים למסמך. כדי לקבל את כל האובייקטים מסוג NamedRange בכרטיסייה כלשהי, משתמשים ב-method‏ DocumentTab.getNamedRanges().

כל סקריפט שגומר לכרטיסייה יכול לגשת ל-NamedRange. כדי למנוע קונפליקטים לא רצויים בין סקריפטים, מומלץ להוסיף לתחילת השמות של הטווחים מחרוזת ייחודית.

חזרה

NamedRange[] – מערך של אובייקטי NamedRange בכרטיסייה, שעשוי לכלול כמה טווחים עם אותו שם.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

הפונקציה מקבלת את כל האובייקטים מסוג NamedRange עם השם שצוין בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמוצמדים למסמך. כדי לקבל את כל האובייקטים מסוג NamedRange בכל כרטיסייה, משתמשים ב-method‏ DocumentTab.getNamedRanges(name). השמות לא חייבים להיות ייחודיים, גם בין כרטיסיות. כמה טווחים שונים באותה כרטיסייה יכולים לשתף את אותו שם, בדומה למחלקה ב-HTML. לעומת זאת, מזהים הם ייחודיים בתוך הכרטיסייה, כמו מזהה ב-HTML.

כל סקריפט שגומר למסמך יכול לגשת ל-NamedRange. כדי למנוע קונפליקטים לא רצויים בין סקריפטים, מומלץ להוסיף לתחילת השמות של הטווחים מחרוזת ייחודית.

פרמטרים

שםסוגתיאור
nameStringשם הטווח, שלא חייב להיות ייחודי.

חזרה

NamedRange[] – מערך של אובייקטי NamedRange בכרטיסייה עם השם שצוין.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

הפונקציה מקבלת את הבחירה של המשתמש בכרטיסייה הפעילה. סקריפט יכול לגשת רק לבחירה של המשתמש שמפעיל אותו, ורק אם הסקריפט קשור למסמך. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

חזרה

Range — ייצוג של הבחירה של המשתמש, או null אם המשתמש לא בחר שום דבר בכרטיסייה, אם רק סוף הפסקה מסוימת נבחר, אם רק סוף הפסקה מסוימת ושורה חדשה נבחרו, או אם הסקריפט לא קשור למסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSupportedLanguageCodes()

הפונקציה מקבלת את כל קודי השפות שנתמכים בקובצי Google Docs.

חזרה

String[] — מערך של קודי שפות.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTab(tabId)

הפונקציה מקבלת את ה-Tab עם המזהה שצוין. אם לא קיים Tab כזה, השיטה מחזירה את הערך null. אפשר לגשת לכרטיסיות בכל רמה של עריכה בתוך עריכה.

פרמטרים

שםסוגתיאור
tabIdStringהמזהה של הכרטיסייה שרוצים לקבל.

חזרה

Tab — ה-Tab עם המזהה שצוין, או null אם אין Tab כזה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

הפונקציה מקבלת את כל ה-Tab שאינם בתצוגת עץ ושהם חלק מהמסמך.

כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שמוטמעת בכרטיסייה אחרת. אפשר לגשת לכרטיסיות הצאצאים באמצעות Tab.getChildTabs().

חזרה

Tab[] – רשימת כל ה-Tab ששייכים למסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

אחזור כתובת ה-URL לגישה למסמך הנוכחי. 

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

חזרה

String – כתובת ה-URL לגישה למסמך הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

הפונקציה מקבלת את רשימת הצופים והמגיבים ב-Document הזה.

חזרה

User[] – מערך של משתמשים עם הרשאת צפייה או הרשאת תגובה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

יצירת Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס לרכיב ספציפי בכרטיסייה הראשונה, או בכרטיסייה הפעילה עבור סקריפטים שמוגבלים למסמך. כדי ליצור Position ביחס למיקום בכרטיסייה כלשהי, משתמשים בשיטה DocumentTab.newPosition(element, offset). הסמן של המשתמש מיוצג כ-Position, בין היתר. 

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

שםסוגתיאור
elementElementהרכיב שצריך להכיל את Position החדש. הרכיב הזה חייב להיות רכיב Text או רכיב קונטיינר כמו Paragraph.
offsetIntegerברכיבי Text, מספר התווים לפני Position. ברכיבים אחרים, מספר רכיבי הצאצאים לפני Position באותו רכיב קונטיינר.

חזרה

Position — השדה החדש Position.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

יצירת בונה המשמש ליצירת אובייקטים מסוג Range מרכיבי כרטיסיות בכרטיסייה הראשונה, או בכרטיסייה הפעילה במקרה של סקריפטים שמקושר למסמך. כדי ליצור בונה שמשמש ליצירת אובייקטים מסוג DocumentRange מרכיבי כרטיסיות בכל כרטיסייה, משתמשים בשיטה DocumentTab.newRange(). 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

חזרה

RangeBuilder – ה-builder החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

הסרת המשתמש הנתון מרשימת העורכים של Document. השיטה הזו לא מונעת ממשתמשים לגשת ל-Document אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Document משותף עם כל הדומיין של המשתמש, או אם ה-Document נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להסיר.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

הסרת המשתמש הנתון מרשימת העורכים של Document. השיטה הזו לא מונעת ממשתמשים לגשת ל-Document אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Document משותף עם כל הדומיין של המשתמש, או אם ה-Document נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להסיר.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Document. השיטה הזו לא משפיעה אם המשתמש הוא עורך, ולא צופה או מגיב. בנוסף, השיטה הזו לא מונעת ממשתמשים לגשת ל-Document אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Document משותף עם כל הדומיין של המשתמש, או אם ה-Document נמצא בתיקיית אחסון שיתופי שהמשתמש יכול לגשת אליה.

בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש שרוצים להסיר.

חזרה

Document — Document לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

הסרת המשתמש מהרשימה של הצופים והמגיבים ב-Document. השיטה הזו לא משפיעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא מונעת ממשתמשים לגשת ל-Document אם הם שייכים לקבוצת משתמשים שיש להם גישה כללית – לדוגמה, אם ה-Document משותף עם כל הדומיין של המשתמש, או אם ה-Document נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.

בקבצים ב-Drive, הפעולה הזו תסיר גם את המשתמש מרשימת העריכה.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שרוצים להסיר.

חזרה

Document — Document לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

שמירת Document הנוכחי. הפקודה גורמת לכך שעדכונים בהמתנה יימחקו ויחולו.

השיטה saveAndClose() מופעלת באופן אוטומטי בסוף ביצוע הסקריפט לכל Document פתוח שאפשר לערוך.

אי אפשר לערוך Document סגור. אפשר להשתמש ב-DocumentApp.openById() כדי לפתוח מחדש מסמך מסוים לעריכה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setActiveTab(tabId)

הפונקציה מגדירה את Tab שנבחר על ידי המשתמש במסמך הנוכחי לכרטיסייה עם המזהה שצוין. 

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

פרמטרים

שםסוגתיאור
tabIdStringהמזהה של הכרטיסייה שרוצים להגדיר כפעילה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

הגדרת הסמן של המשתמש, בהתאם ל-Position. סקריפט יכול לגשת לסמן של המשתמש שמפעיל אותו רק אם הסקריפט קשור למסמך.

העברת Position מ-Tab לא פעיל משנה את הכרטיסייה הפעילה של המשתמש. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

שםסוגתיאור
positionPositionמיקום הסמן החדש.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

הגדרת קוד השפה של המסמך. זו השפה שמוצגת בקטע File > Language (קובץ > שפה) בעורך המסמך. יכול להיות שהיא לא השפה שבה המסמך נכתב בפועל. אפשר להשתמש ב-getSupportedLanguageCodes() כדי לקבל את כל קודי השפה החוקיים.

פרמטרים

שםסוגתיאור
languageCodeStringקוד השפה.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

הגדרת כותרת המסמך.

פרמטרים

שםסוגתיאור
nameStringכותרת המסמך החדש.

חזרה

Document – המסמך הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

הגדרת הבחירה של המשתמש בכרטיסייה הפעילה, בהתאם ל-Range. סקריפט יכול לגשת רק לבחירה של המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט קשור למסמך. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

פרמטרים

שםסוגתיאור
rangeRangeטווח האלמנטים החדש לבחירה.

חזרה

Document — השדה Document, לצורך קישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents